Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PHP-based rest testing #428

Merged
merged 7 commits into from
Feb 29, 2024
Merged

PHP-based rest testing #428

merged 7 commits into from
Feb 29, 2024

Conversation

linawolf
Copy link
Member

@linawolf linawolf commented Feb 29, 2024

depends on #427

@linawolf
Copy link
Member Author

depends on #427

Copy link
Contributor

@garvinhicking garvinhicking left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, now my two cents about this.

In render-guides we have made an abomination that supports all:

  • Makefile
  • Local PHP
  • Docker / DDEV

In that repo, the "single source of truth" is a Makefile, that can accept parameters that allow each command to be executed either locally or via docker.

Then, a composer.json "make" wrapper allows to even run composer scripts calling the makefile (routing it locally, without docker).

That makes render-guides work very adapted, but it's complication hell and I do NOT want this in any of our documentation repositories, that are more "user-facing" than render-guides.

TL;DR: We IMO have these options:

A: Move to a "single source of truth", preferring the existing docker-way. That means, introduce Makefile, remove composer scripts.
--> Low hanging fruits. I pick this. This is also what the PR does.

B: Move to a "single source of truth", removing docker and migrating all tests and execution to be performed locally.
--> So much work to de-tangle runTests and this would IMO put us back too much.

C: Keep the duplication, allow composer AND local use
--> Too much maintenance effort.

D: Introduce the render-guides complexity to satisfy every possibility
--> I could offer to port this, but as mentioned above, this is not worth it IMO.

@linawolf linawolf merged commit 1b87ccd into main Feb 29, 2024
4 checks passed
@linawolf linawolf deleted the task/testing branch February 29, 2024 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants